Unseen Desire: what it does, what it does not do yet, and what to expect
========================================================================

Unseen Desire is a screen-reader accessibility mod for Persona 5 Royal on PC (Steam). It reads the game through your screen
reader and adds sounds and keys so you can find your way without sight. This page tells you honestly how far it goes today,
so you know what you get before you spend money or time. How to use each feature is explained inside the game: the mod's own
tutorials, and the Help in its menu (F1).


In short
--------

- This is an early release.
- I have played it from the very start of the game through the fourth Palace, up to its boss, and the school life
  around it (April into late July).
- In that part, the menus, the story, the battles and the exploration are all read or guided.
- After that part, most of what the game shows is still read (its menus, battles, shops and school life work the same way
  all game long), but the later Palaces have not been played through with the mod yet. Each Palace will get an update after
  it is played and fixed.


What you need
-------------

- Persona 5 Royal, the Steam version for Windows. Other versions (Xbox / Game Pass, consoles) do not work.
- Windows 10 or 11, 64-bit.
- A screen reader. NVDA is the one the mod is tested with. JAWS and other screen readers are supported through Prism but have
  not been tested.
- A keyboard, or a controller. Xbox-style controllers are tested, with Steam Input turned off. Since 0.1.1, PlayStation, Switch
  Pro and other gamepads work without Steam Input or DS4Windows, but only a virtual pad has been tried so far.
- About 1 GB of free space: the mod, its mod loader (Reloaded II) and the game files it reads, which are extracted from your
  own copy of the game. Nothing of the game is downloaded.
- The game's text in English. Other languages have not been tested.


What it reads
-------------

- Menus: the camp menu, items, equipment, Personas, skills, stats, the calendar, the system menus and the settings.
- Dialogue and choices, with the speaker. The voiced lines can be left to the voice actors; the unvoiced ones are always read.
- Battles: your commands, skills and their cost, targets and their known weaknesses, damage, status, the order of turns,
  Hold Ups and negotiations, All-Out Attacks, and the results.
- The Velvet Room: fusion, skill inheritance, the compendium, and the other services you meet early in the game.
- Shops, part-time jobs, the confidants and their ranks, social stats, the phone's chats, the text log, books and other
  activities.
- Cutscenes: descriptions of what the picture shows for nearly every story scene of the game, and the subtitles of the anime
  cutscenes. Both can be turned off.
- Menu and screen descriptions (what a screen looks like), as often as you choose.
- The game's tutorials, and the mod's own tutorials about its keys.
- Many minigames have sound cues added (fishing, batting, darts, the retro games and others). Ones that depend on timing
  still take some practice.


Getting around
--------------

- A scanner lists what is around you, nearest first: people, doors and exits, things to examine, and in Palaces the
  Shadows, treasures, hiding spots and climbing or jumping spots.
- A guide beacon leads you to the chosen thing.
- Where next, since 0.1.1: a key that picks the next place to explore, says it and starts the beacon.
- Auto walk: the mod walks Joker to the chosen thing for you. Since 0.1.6 the game itself moves him, as if you held the
  stick, so he goes the way you would, takes the stairs and goes round things. Hold your run key and he runs; press a
  movement key or move the stick and he is yours at once.
- Wall sounds, a bump sound, the names of rooms and streets, and where you are on request.
- The Third Eye: its route to your target, and each Shadow's colour (how strong it is) while you hold it.
- A map you can move through with a cursor, for Palaces and for the city.
- 3D sound for headphones, optional.

All of the navigation is experimental, and honestly, it is rough. I have played this game many times before, so I already
know how its places look, and I cannot say how the navigation will feel for a new player. Expect to feel overwhelmed or lost
a lot. Also keep in mind that the game needs a lot of awareness from you while you walk, to keep up with what is around you.


What is not done yet, and the limits
------------------------------------

- THE PALACES after the fourth one, and the fourth one's boss fight, are not tested yet. The mod's maps and guides cover
  them and the menus and battles work as anywhere else, but their puzzles, special areas and boss fights may be silent or
  confusing in places until their update.
- MEMENTOS works for exploring, with known gaps; it will be improved in a later update.
- Some screens that open later in the game are not read yet, for example a few of the Velvet Room's later services.
- Some rare battle lines may not say who did something.
- Steam Deck and Linux have not been tested.
- The mod is new: you will probably meet a screen that stays silent, or a line that is wrong.


What the mod changes in the game
--------------------------------

- In Mementos, the Reaper comes after about 6 minutes on a floor instead of 3, to leave time to explore.
- The mod adds its own tutorials about its keys.
- If you play without a controller, the mod shows the game one, so it can walk Joker by the stick: while an auto walk
  runs, the game may draw controller buttons on screen, and the mod still names your own keys. If you play with a
  controller and unplug it during the game, the game no longer shows its message that the controller was disconnected.
- Nothing else of the game is changed. The mod never writes to your saves.


Before you buy the game for this mod
------------------------------------

The first three Palaces, the fourth one up to its boss, and everything before them are what you can count on today. If
you want to be sure the mod works for you: Steam refunds a game bought within 14 days and played for less than 2 hours,
which is enough to install the mod and try the start of the game. Later parts will be covered by updates, one Palace at
a time.


Updates and help
----------------

- Open "Unseen Desire Installer" to update.
- While a Testing version is up, the installer asks which version you want: Stable, which has been played the longest, or
  Testing, which has the newest fixes and features and may have new bugs. To switch, open the installer again and choose the
  other one. Your settings and saves stay as they are.


Reporting a bug
---------------

When something stays silent, says something wrong, or breaks, please tell us. Two things make a report useful: the log,
and a short description.

The log: every time you play, Reloaded II writes everything the mod said and did into a log file, with the time of each
line. To find it:
1. Press Windows and R together, type %AppData%\Reloaded-Mod-Loader-II\Logs and press Enter.
2. The files are named by their date and time, so the newest one, from your last time playing, is at the end of the list:
   press End to get to it. Its name ends with "~ P5R.txt".
3. Send that file with your report. You can copy it while the game is still running, or after you close it.
The log has the folders where the game and the mod are installed, which can include your Windows user name, and the name you
gave the main character. It has nothing else personal.

Your save, when the bug is in a certain place or moment, so it can be tested right there:
1. Press Windows and R together, type %AppData%\SEGA\P5R\Steam and press Enter.
2. Open the folder there: its name is a long number (your Steam account).
3. Open the savedata folder. Each save slot has its own folder: DATA01 is slot 1, DATA02 is slot 2, and so on.
4. Choose the folder of the slot you saved in, press Shift and F10 for its full menu, and choose Send to, then Compressed
   (zipped) folder. A zip of the same name appears beside it.
5. Send that zip with your report, and say which slot it is.
A save only holds your game's progress. Saving shortly before the place where the bug happens helps the most.

The description:
- Where you were in the game and what you were doing: the place, the menu or screen, the battle.
- What you expected to hear, and what you heard instead, or that nothing was said.
- About what time it happened, so it can be found in the log.
- Whether it happens again when you try the same thing.
- Whether you play with the keyboard or a controller.
Tip: the mod's speech history (Ctrl and the left or right bracket) lets you hear the last lines again, to say exactly what
was spoken.